--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Node / ReticulumProjects / MeshChatX.git / files / vendor / rns_filesync / man / man1 / rns-filesync.1
Displaying Raw • Download
vendor/rns_filesync/man/man1/rns-filesync.1 dev (dafd52a7) Text, 2.77 KB
Tb4b4b4.T8b949e\" Man page for rns-filesync
Tb4b4b4.T8b949e\" vim: ft=man
.Tff7b72TH Ta5d6ffRNS-FILESYNC T79c0ff1 Ta5d6ff"2026-07-19" Ta5d6ff"1.0.0" Ta5d6ff"User Commands"
.Tff7b72SH Ta5d6ffNAME
rns-filesync Tffea00\- peer-to-peer directory sync over the Reticulum Network Stack
.Tff7b72SH Ta5d6ffSYNOPSIS
.Tff7b72B Ta5d6ffrns-filesync
[Tffea00\fB-vTffea00\fR|Tffea00\fB--versionTffea00\fR]
[Tffea00\fB--configTffea00\fR Tffea00\fIDIRTffea00\fR]
[Tffea00\fB--rnsconfigTffea00\fR Tffea00\fIDIRTffea00\fR]
[Tffea00\fB-dTffea00\fR Tffea00\fIDIRTffea00\fR]
[Tffea00\fB-iTffea00\fR Tffea00\fINAMETffea00\fR]
[Tffea00\fB-pTffea00\fR Tffea00\fIHASHTffea00\fR]...
[Tffea00\fB-nTffea00\fR]
[Tffea00\fB-aTffea00\fR Tffea00\fISECONDSTffea00\fR]
[Tffea00\fB--allowedTffea00\fR Tffea00\fIFILETffea00\fR]
[Tffea00\fB--allowTffea00\fR Tffea00\fIRULETffea00\fR]...
[Tffea00\fB--permsTffea00\fR Tffea00\fIPERMSTffea00\fR]
[Tffea00\fB--verboseTffea00\fR]...
[Tffea00\fB-qTffea00\fR]
[Tffea00\fB--no-replTffea00\fR]
.Tff7b72SH Ta5d6ffDESCRIPTION
.Tff7b72B Ta5d6ffrns-filesync
synchronizes a directory with peers on the Reticulum network.
It is an embeddable library (MeshChatX, Sideband) with a thin CLI.
There is no TUI.
.Tff7b72PP
Configuration and ACL follow an rngit-like layout under
.Tff7b72I Ta5d6ff~/.rns_filesync/
by default.
.Tff7b72SH Ta5d6ffOPTIONS
.Tff7b72TP
.Tff7b72BR Tffea00\-Ta5d6ffv Ta5d6ff", " Tffea00\-Tffea00\-Ta5d6ffversion
Print version, build date, and git commit (when baked), then exit.
.Tff7b72TP
.Tff7b72BI Tffea00\-Tffea00\-Ta5d6ffconfig Ta5d6ff" DIR"
FileSync config directory (default:
.Tff7b72IR Ta5d6ff~/.rns_filesync Ta5d6ff).
.Tff7b72TP
.Tff7b72BI Tffea00\-Tffea00\-Ta5d6ffrnsconfig Ta5d6ff" DIR"
Reticulum config directory (default:
.Tff7b72IR Ta5d6ff~/.reticulum Ta5d6ff).
.Tff7b72TP
.Tff7b72BR Tffea00\-Ta5d6ffd Ta5d6ff", " Tffea00\-Tffea00\-Ta5d6ffdirectory Ta5d6ff" " Tffea00\fITa5d6ffDIR\fR
Directory to synchronize (overrides
.Tff7b72B Ta5d6ff[filesync] Ta5d6ffdirectory
in config).
.Tff7b72TP
.Tff7b72BR Tffea00\-Ta5d6ffi Ta5d6ff", " Tffea00\-Tffea00\-Ta5d6ffidentity Ta5d6ff" " Tffea00\fITa5d6ffNAME\fR
Identity name stored under the FileSync config directory.
.Tff7b72TP
.Tff7b72BR Tffea00\-Ta5d6ffp Ta5d6ff", " Tffea00\-Tffea00\-Ta5d6ffpeer Ta5d6ff" " Tffea00\fITa5d6ffHASH\fR
Peer identity hash to connect on start (repeatable).
A destination hash is accepted as fallback after the peer has announced.
.Tff7b72TP
.Tff7b72BR Tffea00\-Ta5d6ffn Ta5d6ff", " Tffea00\-Tffea00\-Ta5d6ffno\-monitor
Disable filesystem monitoring.
.Tff7b72TP
.Tff7b72BR Tffea00\-Ta5d6ffa Ta5d6ff", " Tffea00\-Tffea00\-Ta5d6ffannounce\-interval Ta5d6ff" " Tffea00\fITa5d6ffSECONDS\fR
Announce interval in seconds.
.Tff7b72TP
.Tff7b72BI Tffea00\-Tffea00\-Ta5d6ffallowed Ta5d6ff" FILE"
Path to an
.Tff7b72B Ta5d6ff.allowed
ACL file (rngit-style
.Tff7b72I Ta5d6ffpermission:target
lines).
.Tff7b72TP
.Tff7b72BI Tffea00\-Tffea00\-Ta5d6ffallow Ta5d6ff" RULE"
ACL rule such as
.Tff7b72I Ta5d6ffr:all
or
.Tff7b72IR Ta5d6ffw:HASH
(repeatable).
.Tff7b72TP
.Tff7b72BI Tffea00\-Tffea00\-Ta5d6ffperms Ta5d6ff" PERMS"
Legacy shorthand for bare
.Tff7b72B Tffea00\-Tffea00\-Ta5d6ffallow
hashes (
.Tff7b72IR Ta5d6ffr Ta5d6ff,
.Tff7b72IR Ta5d6ffw Ta5d6ff,
.Tff7b72IR Ta5d6ffd Ta5d6ff,
.Tff7b72IR Ta5d6ffrw Ta5d6ff,
.Tff7b72IR Ta5d6ffrwd Ta5d6ff).
.Tff7b72TP
.Tff7b72B Tffea00\-Tffea00\-Ta5d6ffverbose
Increase Reticulum log verbosity (repeatable).
.Tff7b72TP
.Tff7b72BR Tffea00\-Ta5d6ffq Ta5d6ff", " Tffea00\-Tffea00\-Ta5d6ffquiet
Reduce logging.
.Tff7b72TP
.Tff7b72B Tffea00\-Tffea00\-Ta5d6ffno\-repl
Run without the interactive command prompt.
.Tff7b72SH Ta5d6ffINTERACTIVE Ta5d6ffCOMMANDS
When the REPL is enabled:
.Tff7b72BR Ta5d6ffstatus Ta5d6ff,
.Tff7b72BR Ta5d6ffpeers Ta5d6ff,
.Tff7b72BR Ta5d6fffiles Ta5d6ff,
.Tff7b72BR Ta5d6ffconnect Ta5d6ff,
.Tff7b72BR Ta5d6ffdisconnect Ta5d6ff,
.Tff7b72BR Ta5d6ffbrowse Ta5d6ff,
.Tff7b72BR Ta5d6ffdownload Ta5d6ff,
.Tff7b72BR Ta5d6ffannounce Ta5d6ff,
.Tff7b72BR Ta5d6ffquit Ta5d6ff.
.Tff7b72SH Ta5d6ffFILES
.Tff7b72TP
.Tff7b72I Ta5d6ff~/.rns_filesync/config
Main FileSync configuration (ConfigObj).
.Tff7b72TP
.Tff7b72I Ta5d6ff~/.rns_filesync/identities/
Stored identities.
.Tff7b72TP
.Tff7b72I Ta5d6ff<sync_dir>.allowed
Optional sidecar ACL next to the sync directory.
.Tff7b72SH Ta5d6ffEXAMPLES
.Tff7b72nf
rns-filesync -d ~/shared
rns-filesync -d ~/shared -p 9710b86ba12c42d1d8f30f74fe509286
rns-filesync -v
.Tff7b72fi
.Tff7b72SH Ta5d6ffSEE Ta5d6ffALSO
.Tff7b72BR Ta5d6ffrnsd Ta5d6ff(1),
.Tff7b72BR Ta5d6ffrnstatus Ta5d6ff(1)
.Tff7b72PP
Documentation and Sideband plugins:
.Tff7b72I Ta5d6ffhttps://github.com/Quad4-Software/RNS-Filesync
.Tff7b72SH Ta5d6ffAUTHOR
Quad4 Software
──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────